<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html languagee="en">
<head>
<title>XOOPS Update</title>
<style>
.outer { background-color: #808080; }
td,th { padding: 4px; background: #e8e8e8;}
.head th  { padding: 4px; background: #d0d0d0; }
.bnf { color: #008000; }
.note { font-size: 80%; color: #800000; padding: 0.5em;}

.even td,.odd td { virtical-align: top; }
.chg { color: #c00; } 
.same { color: #00c; } 
.mod { color: #f08; }
pre { color: #620; }
em { color: #084; font-weight: bold;}
ol li { list-style: decimal; }
</style>
</head>
<body>
<style>
li.rel { list-style: none; font-weight: bold; }
ul#changes { text-indent: 1em;}
.note { color: #800000; }
</style>

  <h4>XoopsUpdate</h4>

  <p>"XoopsUpdate" is update support system for XOOPS Core and Modules update.
  <b>Update module</b>(this) is a client XoopsUpdate Service.</p>

  <p>Update module which provide following function based on information from
    the Server by <a href="#scriptupdate">ScriptUpdate LLC</a>.
  </p>
  <ul>
    <li>Update information for XOOPS and Modules</li>
    <li>Checking installed file and inspect <a href="#legend">changes</a></li>
    <li>Make backup and update archive (changed file only)</li>
    <li>Automatic Update - Need <a href="#install">Unix System settings</a></li>
  </ul>

  <ul>
  <li><a href="#config">Preferences</a></li>
  <li><a href="#changes">Changes</a></li>
  </ul>

  <hr>

  <a name="howtouse"></a><h5>How to Use</h5>

  <p>After install, Need to set following checking/update packages at "Register Update." in admin page. For example, You want follow XOOPS 2.0 core, You select Package Name "XOOPS2" and set it.</p>

  <p>Go to "Check and Update" menu, Doing check and report list displayed about current your system.</p>

  <p>In some case, Your server can not get update information from the
    XoopsUpdate Server. Update module need to work update information.
    In this case, You can get update information by manual from <a href="http://www.scriptupdate.jp/modules/server/">the Update Server</a>.
    You select "Update Info." admin menu, and Import Update information.</p>

  <p>Update is following steps in this system</p>
  <ol>
    <li>Select status "Modify" package. Checking detail and register changes
      -- This operation is recognize current status is correct.</li>
    <li>Register modification finished, and there is newer update information. Your can proceed update.</li>
    <li>When ``<a href="#install">Unix System Settings</a>''
      make correct. There is "Do Update" button displayed. In
      this case, You can do update only this button.  And this case,
      You can undo update "Update Revert" button, right now update.</li>
    <li>You can get archives from "Backup changes" and "Update
      Archive".  This archives use upload override, You can do
      update and undo update in manual.
    </li>
  </ol>

  <a name="install"></a><h5>Unix System Settings</h5>

  <p>Update module can do automatic update. You want
    do <b>automatic update</b> need settings as follow.  In this
    settings for same user permittion as upload file.</p>
  <blockquote>
  <div>add entry in <tt>/etc/sudoers</tt></div>
  <pre>apache  ALL=(<em>username</em>) NOPASSWD: <em>XOOPS_ROOT_PATH</em>/modules/update/fileutil.sh</pre>
  <ul>
    <li><em>username</em> ... unix user name for uploading XOOPS files</li>
    <li><em>XOOPS_ROOT_PATH</em> ... installed XOOPS foler path</li>
  </ul>
  </blockquote>

  <a name="legend"></a><h5>Package Changes</h5>

  <p>Display Package detail and what is mean</p>

  Update detection, You can inspect diff style in "change" link.
  Also, Newer version different, some marked and color in files for help.

  <blockquote>
    <table cellspacing="1" cellpadding="4" class="outer" width="100%">
    <tr><th>mark</th><th>meaning</th></tr>
    <tr>
      <td align="center" class="same">=</td>
      <td>No changes (only CVS tag)</td>
    </tr>
    <tr>
      <td align="center" class="same">+</td>
      <td>only CRLF add in eof</td>
    </tr>
    <tr>
      <td align="center" class="same">(None)</td>
      <td>Update in newer version</td>
    </tr>
    <tr>
      <td align="center" class="mod">*</td>
      <td>Modify in current, no conflict in newer version file.</td>
    </tr>
    <tr>
      <td align="center" class="chg">(None)</td>
      <td>There is conflict changes. You need consider marge changes.</td>
    </tr>
    </table>

    Examples:
    <table cellspacing="1" class="outer" width="100%">
    <tr><th>Status</th><th>File</th></tr>
    <tr class="odd"><td><a>Change</a></td><td class="same">admin.php =</td></tr>
    <tr class="even"><td><a>Change</a></td><td class="same">class/criteria.php +</td></tr>
    <tr class="odd"><td><a>Change</a></td><td class="mod">class/database/database.php *</td></tr>
    <tr class="even"><td><a>Change</a></td><td class="chg">class/database/msqldatabase.php</td></tr>
    </table>
  </blockquote>

  <a name="config"></a><h2>Module Preferences</h2>

  <blockquote>
    <table border="0" cellspacing="1" cellpadding="4" class="outer">
      <tr class="head"><th>Item</th><th>Value</th><th>Description</th></tr>
      <tr class="even">
        <th>Update Server URL</th>
        <td>http://scriptupdate.jp/server/<br/>
	  the XoopsUpdate Server by ScriptUpdate LLC.
	</td>
	<td>The Server URL that provide Update Information.</td>
      </tr>
      <tr class="odd">
        <th>Update info cache Time</th>
	<td><u>3600</u> (1 hour)</td>
	<td>Fetched update information, that keeping cache time(unit second).</td>
      </tr>
      <tr class="even">
        <th>Conflict escape method</th>
	<td><u>Keep Old file</u><br/>Override New file<br/>Force Update patch</td>
	<td>When detection conflict update, setting method to try.<br/>Local modification will be lost if select override new file.</td>
      </tr>
    </table>
  </blockquote>

  <a name="changes"></a><h5>Changes</h5>

<dl>
  <dt>2010/01/09 update 0.91</dt>
  <dd>
    <ul>
      <li>support XOOPS 2.0 later</li>
      <li>using altsys module if exist</li>
    </ul>
  </dd>
  <dt>2008/02/25 update 0.90</dt>
  <dd>
    <ul>
      <li>Destination change differ to newer version</li>
      <li>Fix problem when directory name changed</li>
      <li>Fix newer version miss sense</li>
      <li>Change delegate file select method</li>
    </ul>
  </dd>
  <dt>2008/01/09 update 0.89</dt>
  <dd>
    <ul>
      <li>Auto replace EOL when apply stored diff</li>
      <li>fix update info unsense when local and network info using both</li>
      <li>Register packages info back to same page</li>
    </ul>
  </dd>
  <dt>2008/01/06 update 0.88</dt>
  <dd>
    <ul>
      <li>fix field type from text to longblob in database</li>
      <li>confirm getting files used by hash</li>
    </ul>
  </dd>
  <dt>2007/10/30 update 0.87</dt>
  <dd>
    <ul>
      <li>fix dulicatable module conflict problem.</li>
      <li>fix update_cache table not list in xoops_version.php </li>
      <li>remove update working folder</li>
    </ul>
  </dd>
  <dt>2007/08/04 update 0.86</dt>
  <dd>
    <ul>
  <li class="rel"></li>
  <li>Package information display in Option settings</li>
  <li>fix XOOPS_TRUST_PATH not work</li>
    </ul>
  </dd>
  <dt>2007/07/15 update 0.85</dt>
  <dd>
    <ul>
      <li class="rel"></li>
      <li>fix after update mistake display sync.</li>
      <li>change Cache using database table (update_cache)</li>
      <li>fix backup recovery expire problem</li>
      <li>Support renamed module</li>
      <li>Check initial by older package information</li>
      <li>fix option setting can not all off.</li>
    </ul>
  </dd>
  <dt>2007/07/09 update 0.84</dt>
  <dd>
    <ul>
      <li class="rel"></li>
      <li>Register Update package order changes</li>
      <li>After change register packages, clear information cache</li>
      <li>Search more version not equivalent</li>
      <li>Display module update status</li>
      <li>XOOPS_TRUST_ROOT (alternative root) mechanism added</li>
    </ul>
  </dd>
  <dt>2007/06/22 update 0.83</dt>
  <dd>
    <ul>
      <li>fix base system (XOOPS2-JP vs XCL) conflict.</li>
    </ul>
  </dd>
  <dt>2007/06/21 update 0.82</dt>
  <dd>
    <ul>
      <li>fix uninstalled module handling</li>
      <li>support XOOPS Cube Legacy 2.1</li>
      <li>fix module version number handling (e.g numeirc 1.0 makes "1")</li>
      <li>try unformaly version number used in module</li>
      <li>fix domain and path allow '/' in Authorization</li>
    </ul>
  </dd>
  <dt>2007/01/04 update 0.81</dt>
  <dd>
    <ul>
      <li>fix update failure</li>
    </ul>
  </dd>
  <dt>2006/12/05 update 0.8</dt>
  <dd>
    <ul>
      <li>Support session Authorization -- for customized update</li>
      <li>Support Duplicatable module</li>
      <li>fix many bugs</li>
    </ul>
  </dd>
  <dt>2006/07/19 update 0.74 (alpha)</dt>
</dl>

  <a name="scriptupdate"></a><h5>about ScriptUpdate LLC</h5>

  <p><a href="http://www.scriptupdate.jp/">ScriptUpate LLC</a> is a
    specialization company for update and maintenance script based system.
    This module developed and distributed by ScriptUpdate LLC</p>

<hr>
<div>$Id: help.html,v 1.6 2010/01/09 07:44:28 nobu Exp $</div>
</body>
</html>
